New

Description

The New message is an event type that signifies the creation of a new appointment in the EHR system. This message is typically sent outbound from the EHR to notify external systems or applications about the newly booked appointment.

API endpoints for New

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/surgical-scheduling/new.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for New

New - Sample Payload

{
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "EventType": "New",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "f22b2c2f-06b1-4b6f-aa9e-95633ec18a8a",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "d3f53b30-a827-4de8-a604-ae61a9c0c488",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "8cdc9db6-2712-409e-a7ec-87fd95cc2987",
            "AttemptID": "c8dc9489-48cb-4ef7-bdcb-e69153bac8cd"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "ade3c97a-ca44-4bc4-8200-a93e6730da98",
            "IDType": "EHRID"
         },
         {
            "ID": "7840dc01-2541-4a53-a1ae-d78d3213085d",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "James",
         "MiddleName": "Alex",
         "LastName": "Smith",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hill Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Procedures": [
      {
         "Code": "6391",
         "Codeset": null,
         "Description": "Appendectomy",
         "DateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120,
         "ProcedureInfo": [
            {
               "Description": "Laterality",
               "Value": "unilateral left"
            }
         ]
      }
   ],
   "SurgeryStaff": [
      {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Bobby",
         "LastName": "Grant",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53703",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "Role": {
            "Code": "1.1",
            "Codeset": null,
            "Description": "Primary Surgeon"
         },
         "StartDateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120
      }
   ],
   "SurgicalInfo": [
      {
         "Code": "23457",
         "Codeset": "EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "1535135",
         "Codeset": "EHR Codes",
         "Description": "Use Preference Cards",
         "Value": "Y"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "VisitDateTime": null,
      "Status": null,
      "Duration": null,
      "PatientClass": null,
      "Notes": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Bobby",
         "LastName": "Grant",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53703",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "MGM Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null,
            "DocumentedDateTime": null
         }
      ],
      "Equipment": []
   },
   "SurgicalCase": {
      "Number": null,
      "Status": null
   }
}